<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libBigWig: bwRTreeNode_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libBigWig
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">bwRTreeNode_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A node within an R-tree holding the index for data.  
 <a href="structbwRTreeNode__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="bwValues_8h_source.html">bwValues.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa2dac9df29c6b9eaaf4000e70f3e1540"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#aa2dac9df29c6b9eaaf4000e70f3e1540">isLeaf</a></td></tr>
<tr class="separator:aa2dac9df29c6b9eaaf4000e70f3e1540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a286f78e61ff30c50a6b862a62dac119c"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#a286f78e61ff30c50a6b862a62dac119c">nChildren</a></td></tr>
<tr class="separator:a286f78e61ff30c50a6b862a62dac119c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39f6795d06ac6d532c6673d9ec456635"><td class="memItemLeft" align="right" valign="top">uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#a39f6795d06ac6d532c6673d9ec456635">chrIdxStart</a></td></tr>
<tr class="separator:a39f6795d06ac6d532c6673d9ec456635"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8a64d389746640ca8b67a0e060792c4"><td class="memItemLeft" align="right" valign="top">uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#af8a64d389746640ca8b67a0e060792c4">baseStart</a></td></tr>
<tr class="separator:af8a64d389746640ca8b67a0e060792c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a618ace340992c3a00c1f02e6f4e89381"><td class="memItemLeft" align="right" valign="top">uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#a618ace340992c3a00c1f02e6f4e89381">chrIdxEnd</a></td></tr>
<tr class="separator:a618ace340992c3a00c1f02e6f4e89381"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2780034368ea3ec077c2b6d7bf16aff6"><td class="memItemLeft" align="right" valign="top">uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#a2780034368ea3ec077c2b6d7bf16aff6">baseEnd</a></td></tr>
<tr class="separator:a2780034368ea3ec077c2b6d7bf16aff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d0838a23fbd7164322ef2ee74a63418"><td class="memItemLeft" align="right" valign="top">uint64_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#a8d0838a23fbd7164322ef2ee74a63418">dataOffset</a></td></tr>
<tr class="separator:a8d0838a23fbd7164322ef2ee74a63418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9caccee1915cb22f50b0b794847317d"><td class="memItemLeft" >union {</td></tr>
<tr class="memitem:a2bf491ce09f970f4bf865f7b41f8d8e2"><td class="memItemLeft" >&#160;&#160;&#160;uint64_t *&#160;&#160;&#160;<a class="el" href="structbwRTreeNode__t.html#ad5b7bd4b20a5eab86d6f74bded36800b">size</a></td></tr>
<tr class="separator:a2bf491ce09f970f4bf865f7b41f8d8e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d2849e1b4c9600d2e54d164a4e7a02d"><td class="memItemLeft" >&#160;&#160;&#160;struct <a class="el" href="structbwRTreeNode__t.html">bwRTreeNode_t</a> **&#160;&#160;&#160;<a class="el" href="structbwRTreeNode__t.html#aeda9708050f25cd445d10ebce2540a06">child</a></td></tr>
<tr class="separator:a3d2849e1b4c9600d2e54d164a4e7a02d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9caccee1915cb22f50b0b794847317d"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbwRTreeNode__t.html#af9caccee1915cb22f50b0b794847317d">x</a></td></tr>
<tr class="separator:af9caccee1915cb22f50b0b794847317d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A node within an R-tree holding the index for data. </p>
<p>Note that there are two types of nodes: leaf and twig. Leaf nodes point to where data actually is. Twig nodes point to additional index nodes, which may or may not be leaves. Each of these nodes has additional children, which may span multiple chromosomes/contigs.</p>
<p>With the start/end position, these positions refer specifically to the chromosomes specified in chrIdxStart/chrIdxEnd. Any chromosomes between these are completely spanned by a given child. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a2780034368ea3ec077c2b6d7bf16aff6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2780034368ea3ec077c2b6d7bf16aff6">&#9670;&nbsp;</a></span>baseEnd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t* bwRTreeNode_t::baseEnd</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A list of the end position of each child. </p>

</div>
</div>
<a id="af8a64d389746640ca8b67a0e060792c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8a64d389746640ca8b67a0e060792c4">&#9670;&nbsp;</a></span>baseStart</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t* bwRTreeNode_t::baseStart</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A list of the start position of each child. </p>

</div>
</div>
<a id="aeda9708050f25cd445d10ebce2540a06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeda9708050f25cd445d10ebce2540a06">&#9670;&nbsp;</a></span>child</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structbwRTreeNode__t.html">bwRTreeNode_t</a>** bwRTreeNode_t::child</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Twigs only: The child node(s). </p>

</div>
</div>
<a id="a618ace340992c3a00c1f02e6f4e89381"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a618ace340992c3a00c1f02e6f4e89381">&#9670;&nbsp;</a></span>chrIdxEnd</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t* bwRTreeNode_t::chrIdxEnd</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A list of the end chromosome indices of each child. </p>

</div>
</div>
<a id="a39f6795d06ac6d532c6673d9ec456635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39f6795d06ac6d532c6673d9ec456635">&#9670;&nbsp;</a></span>chrIdxStart</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t* bwRTreeNode_t::chrIdxStart</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A list of the starting chromosome indices of each child. </p>

</div>
</div>
<a id="a8d0838a23fbd7164322ef2ee74a63418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d0838a23fbd7164322ef2ee74a63418">&#9670;&nbsp;</a></span>dataOffset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t* bwRTreeNode_t::dataOffset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>For leaves, the offset to the on-disk data. For twigs, the offset to the child node. </p>

</div>
</div>
<a id="aa2dac9df29c6b9eaaf4000e70f3e1540"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2dac9df29c6b9eaaf4000e70f3e1540">&#9670;&nbsp;</a></span>isLeaf</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t bwRTreeNode_t::isLeaf</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Is this node a leaf? </p>

</div>
</div>
<a id="a286f78e61ff30c50a6b862a62dac119c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a286f78e61ff30c50a6b862a62dac119c">&#9670;&nbsp;</a></span>nChildren</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t bwRTreeNode_t::nChildren</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The number of children of this node, all lists have this length. </p>

</div>
</div>
<a id="ad5b7bd4b20a5eab86d6f74bded36800b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5b7bd4b20a5eab86d6f74bded36800b">&#9670;&nbsp;</a></span>size</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t* bwRTreeNode_t::size</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Leaves only: The size of the data block. </p>

</div>
</div>
<a id="af9caccee1915cb22f50b0b794847317d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9caccee1915cb22f50b0b794847317d">&#9670;&nbsp;</a></span>x</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union { ... }  bwRTreeNode_t::x</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A union holding either size or child </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="bwValues_8h_source.html">bwValues.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 8 2020 13:48:36 for libBigWig by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
